home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmTextFieldGetSubstringWcs.z / XmTextFieldGetSubstringWcs
Encoding:
Text File  |  2003-11-18  |  4.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmTTTTVVVVeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_T_e_x_t_F_i_e_l_d_G_e_t_S_u_b_s_t_r_i_n_g_W_c_s - A TextField function that
  10.       retrieves a a    portion    of a wide character internal text
  11.       buffer
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.       #include <Xm/TextF.h>
  15.  
  16.       int XmTextFieldGetSubstringWcs (wwwwiiiiddddggggeeeetttt,,,, ssssttttaaaarrrrtttt,,,, nnnnuuuummmm____cccchhhhaaaarrrrssss,,,, bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee,,,, bbbbuuuuffffffffeeeerrrr)
  17.            _W_i_d_g_e_t       wwwwiiiiddddggggeeeetttt;
  18.            _X_m_T_e_x_t_P_o_s_i_t_i_o_nssssttttaaaarrrrtttt;
  19.            _i_n_t       nnnnuuuummmm____cccchhhhaaaarrrrssss;
  20.            _i_n_t       bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee;
  21.            _w_c_h_a_r__t       *bbbbuuuuffffffffeeeerrrr;
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.       _X_m_T_e_x_t_F_i_e_l_d_G_e_t_S_u_b_s_t_r_i_n_g_W_c_s retrieves a copy of a portion of
  25.       the internal text buffer of a    TextField widget that is
  26.       stored in a wide character format.  The function copies a
  27.       specified number of characters from a    given start position
  28.       in the internal text buffer into a buffer provided by    the
  29.       application.    A NULL terminator is placed at the end of the
  30.       copied data.
  31.  
  32.       wwwwiiiiddddggggeeeetttt
  33.            Specifies the TextField widget ID.
  34.  
  35.       ssssttttaaaarrrrtttt
  36.            Specifies the beginning character position from which
  37.            the data    will be    retrieved.  This is an integer number
  38.            of characters from the beginning    of the text buffer.
  39.            The first character position is 0.
  40.  
  41.       nnnnuuuummmm____cccchhhhaaaarrrrssss
  42.            Specifies the number of _w_c_h_a_r__t characters to be    copied
  43.            into the    provided buffer.
  44.  
  45.       bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee
  46.            Specifies the size of the supplied buffer as a number
  47.            of _w_c_h_a_r__t storage locations.  The minimum size is
  48.            nnnnuuuummmm____cccchhhhaaaarrrrssss + 1.
  49.  
  50.       bbbbuuuuffffffffeeeerrrr
  51.            Specifies the wide character buffer into    which the
  52.            internal    text buffer will be copied.
  53.  
  54.       For a    complete definition of TextField and its associated
  55.       resources, see _X_m_T_e_x_t_F_i_e_l_d(_3_X).
  56.  
  57.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  58.       _X_m_C_O_P_Y__S_U_C_C_E_E_D_E_D
  59.            The function was    successful.
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmTTTTVVVVeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       _X_m_C_O_P_Y__F_A_I_L_E_D
  75.            The function failed because it was unable to copy the
  76.            specified number    of characters into the buffer
  77.            provided.  The buffer size may be insufficient.    The
  78.            contents    of bbbbuuuuffffffffeeeerrrr are undefined.
  79.  
  80.       _X_m_C_O_P_Y__T_R_U_N_C_A_T_E_D
  81.            The requested number of characters extended beyond the
  82.            internal    buffer.     The function copied characters    to the
  83.            end of the buffer and terminated    the string with    a NULL
  84.            terminator; fewer than nnnnuuuummmm____cccchhhhaaaarrrrssss    characters were
  85.            copied.
  86.  
  87.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  88.       _X_m_T_e_x_t_F_i_e_l_d(_3_X) and _X_m_T_e_x_t_F_i_e_l_d_G_e_t_S_u_b_s_t_r_i_n_g(_3_X).
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.